Skip to content

Simplify model interface#231

Closed
Kircheneer wants to merge 1 commit intodevelopfrom
simplify-model-interface
Closed

Simplify model interface#231
Kircheneer wants to merge 1 commit intodevelopfrom
simplify-model-interface

Conversation

@Kircheneer
Copy link
Contributor

@Kircheneer Kircheneer commented Jun 20, 2023

This is a draft of an attempt to simplify the interface for defining models a bit. Here is what an example model definition now might look like:

from typing import Annotated, List. Optional

from diffsync.enum import DiffSyncFieldtype
from diffsync import DIffSyncModel


class City(DiffSyncModel):
    _modelname = "city"

    name: Annotated[str, DiffSyncFieldType.IDENTIFIER]
    population: Annotated[int, DiffSyncFieldType.ATTRIBUTE]


class Country(DebugModel):
    _modelname = "country"

    name: Annotated[str, DiffSyncFieldType.IDENTIFIER]
    iso_code: Annotated[Optional[str], DiffSyncFieldType.ATTRIBUTE]
    cities: Annotated[List[City], DiffSyncFieldType.CHILDREN, "city"] = []

Open points

  • Evaluate, whether this breaking change (eyeing at 2.0) is worth it
  • Documentation
  • Think about further possibilites for simplification

@Kircheneer Kircheneer force-pushed the simplify-model-interface branch from ee108b6 to 52cd49b Compare June 20, 2023 15:06
@Kircheneer Kircheneer mentioned this pull request Jun 20, 2023
Closed
7 tasks
@Kircheneer Kircheneer force-pushed the simplify-model-interface branch from 52cd49b to 723f88f Compare June 20, 2023 15:20
@itdependsnetworks
Copy link
Contributor

itdependsnetworks commented Jun 20, 2023

I thought that this was only available in 3.9 and above? https://docs.python.org/3/library/typing.html#typing.Annotated

@Kircheneer
Copy link
Contributor Author

Kircheneer commented Jun 21, 2023

I thought that this was only available in 3.9 and above? https://docs.python.org/3/library/typing.html#typing.Annotated

True actually, I didn't know. Should use this for compatibility

@Kircheneer
Copy link
Contributor Author

Kircheneer commented Feb 15, 2024

Closing for now.

@Kircheneer Kircheneer closed this Feb 15, 2024
@jdrew82 jdrew82 deleted the simplify-model-interface branch March 27, 2025 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@glennmatthews glennmatthews Awaiting requested review from glennmatthews glennmatthews will be requested when the pull request is marked ready for review glennmatthews is a code owner

@michalis1 michalis1 Awaiting requested review from michalis1 michalis1 will be requested when the pull request is marked ready for review michalis1 is a code owner

@jdrew82 jdrew82 Awaiting requested review from jdrew82 jdrew82 will be requested when the pull request is marked ready for review jdrew82 is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Kircheneer @itdependsnetworks